<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

<html lang="en">
<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<meta name="generator" content="PHPDoctor 2RC4 (http://peej.github.com/phpdoctor/)">
<meta name="when" content="Fri, 23 Jul 2010 20:16:21 +0000">

<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">

<title>HR_apiResponse (Hosting Reborn API PHP Library)</title>

</head>
<body id="definition" onload="parent.document.title=document.title;">

<div class="header">
<h1>Hosting Reborn API PHP Library</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../com/hostingreborn/api/package-summary.html">Package</a></li>
<li class="active">Class</li>
<li><a href="../../../com/hostingreborn/api/package-tree.html">Tree</a></li>
<li><a href="../../../overview-files.html">Files</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>

<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../com/hostingreborn/api/hr_apiresponse.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>

<div class="qualifiedName">com\hostingreborn\api\HR_apiResponse</div>
<a href="../../../source/hr_apiresponse.class.php.html#line16" class="location">HR_apiResponse.class.php at line 16</a>

<h1>Class HR_apiResponse</h1>

<pre class="tree"><strong>HR_apiResponse</strong><br /></pre>

<hr>

<p class="signature">public  class <strong>HR_apiResponse</strong></p>

<div class="comment" id="overview_description"><p><p>The response to a request sent from HR_api.</p>
<p>The HR_apiResponse class deserialises the API response and prepares the data to be queried by classes that extend HR_api.</p></p></div>

<dl>
<dt>Author:</dt>
<dd>Jon Cram <jon@hostingreborn.com></dd>
<dt>Copyright:</dt>
<dd>https://api.hostingreborn.com/code/copyright/</dd>
<dt>License:</dt>
<dd>https://api.hostingreborn.com/code/license/</dd>
<dt>Version:</dt>
<dd>1.0 $Date: 2010/07/04 22:51:02 $ $Revision: 2c423d307a13 $ /</dd>
</dl>
<hr>

<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#__construct()">__construct</a>(mixed responseXML, mixed url)</p><p class="description"></p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getCollection()">getCollection</a>(array queries)</p><p class="description"></p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#getSet()">getSet</a>(str query)</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#getValue()">getValue</a>(string query, mixed type)</p><p class="description"></p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#toXML()">toXML</a>()</p><p class="description"></p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#wasSuccessful()">wasSuccessful</a>()</p><p class="description"></p></td>
</tr>
</table>

<h2 id="detail_method">Method Detail</h2>
<a href="../../../source/hr_apiresponse.class.php.html#line48" class="location">HR_apiResponse.class.php at line 48</a>

<h3 id="__construct()">__construct</h3>
<code class="signature">public  void <strong>__construct</strong>(mixed responseXML, mixed url)</code>
<div class="details">
<p></p></div>

<hr>

<a href="../../../source/hr_apiresponse.class.php.html#line110" class="location">HR_apiResponse.class.php at line 110</a>

<h3 id="getCollection()">getCollection</h3>
<code class="signature">public  array <strong>getCollection</strong>(array queries)</code>
<div class="details">
<p></p></div>

<hr>

<a href="../../../source/hr_apiresponse.class.php.html#line147" class="location">HR_apiResponse.class.php at line 147</a>

<h3 id="getSet()">getSet</h3>
<code class="signature">public  void <strong>getSet</strong>(str query)</code>
<div class="details">
</div>

<hr>

<a href="../../../source/hr_apiresponse.class.php.html#line72" class="location">HR_apiResponse.class.php at line 72</a>

<h3 id="getValue()">getValue</h3>
<code class="signature">public  mixed <strong>getValue</strong>(string query, mixed type)</code>
<div class="details">
<p></p><dl>
<dt>Parameters:</dt>
<dd>query - XPath query</dd>
</dl>
</div>

<hr>

<a href="../../../source/hr_apiresponse.class.php.html#line169" class="location">HR_apiResponse.class.php at line 169</a>

<h3 id="toXML()">toXML</h3>
<code class="signature">public  string <strong>toXML</strong>()</code>
<div class="details">
<p></p><dl>
<dt>Returns:</dt>
<dd>An XML representation of the server response</dd>
</dl>
</div>

<hr>

<a href="../../../source/hr_apiresponse.class.php.html#line100" class="location">HR_apiResponse.class.php at line 100</a>

<h3 id="wasSuccessful()">wasSuccessful</h3>
<code class="signature">public  boolean <strong>wasSuccessful</strong>()</code>
<div class="details">
<p></p></div>

<hr>

<div class="header">
<h1>Hosting Reborn API PHP Library</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../com/hostingreborn/api/package-summary.html">Package</a></li>
<li class="active">Class</li>
<li><a href="../../../com/hostingreborn/api/package-tree.html">Tree</a></li>
<li><a href="../../../overview-files.html">Files</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>

<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../com/hostingreborn/api/hr_apiresponse.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>

<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>

</body>

</html>